Functions
KER_RES KER_API	upiNfcInit (KER_CTX_INIT_PARAM const KER_VOID pConfigID, KER_INT16U usConfigIDLen, const KER_CHAR pchKernelFiles, KER_INT16U usKernelFilesLen)
	Performs kernel initialization. More...

KER_RES KER_API	upiNfcDeInit (KER_CTX_SINGLE_PARAM)
	Performs kernel de-initialization. More...

KER_BOOL KER_API	upiNfcVerInfo (KER_CTX_PARAM const KER_CHAR *ppchEmvVer, KER_INT16U pusEmvVerLen, const KER_CHAR *ppchLibVer, KER_INT16U pusLibVerLen)
	Obtains emv kernel library version info. More...

KER_RES KER_API	upiNfcTran (KER_CTX_PARAM const NFC_EP_PRE_DATA pEpPRE, const NFC_EP_PPSE_DATA pEpPPSE, const NFC_EP_TRAN_DATA pEpTranData, KER_TRAN ppTran, NFC_OUTCOME *ppOutcome)
	Initiates transaction processing by kernel. More...

KER_BOOL KER_API	upiNfcTranRelease (KER_CTX_PARAM KER_TRAN *pTran)
	Releases NFC Transaction container structure. More...

KER_RES KER_API	upiNfcGetData (KER_CTX_PARAM KER_TRAN pTran, KER_INT16U usOptions, KER_BYTE pbtData, KER_INT16U *pusDataLen)
	Transaction data request. More...

KER_RES KER_API	upiNfcGetDataByTag (KER_CTX_PARAM KER_TRAN pTran, KER_INT16U usOptions, const KER_BYTE pbtTag, KER_BYTE btTagSize, KER_BYTE pbtData, KER_INT16U pusDataSize)
	transaction data request More...

KER_RES KER_API	upiNfcGetDataByTagList (KER_CTX_PARAM KER_TRAN pTran, KER_INT16U usOptions, const KER_BYTE pbtTagList, KER_INT16U usTagListSize, KER_BYTE pbtData, KER_INT16U pusDataSize)
	transaction data request More...

KER_BOOL KER_API	upiCheckOption (KER_CTX_PARAM KER_TRAN pTran, KER_INT16U usOption, KER_INT16U usParam, KER_VOID pParam)
	Check options callback Define this function outside the lib to provide kernel options. More...

Detailed Description

NFC UPI KERNEL library export functions (with uniqe names to link several kernel libs in one project)

Function Documentation

◆ upiCheckOption()

KER_BOOL KER_API upiCheckOption	(	KER_CTX_PARAM KER_TRAN *	pTran,
		KER_INT16U	usOption,
		KER_INT16U	usParam,
		KER_VOID *	pParam
	)

Check options callback Define this function outside the lib to provide kernel options.

Parameters

[in]	pTran	- pointer to the transaction structure (obtained by upiNfcTran)
[in]	usOption	- option to check (NFC_KER_OPT_DEBUG, NFC_KER_OPT_RRP)
[in]	usParam	- reserved.
[in]	pParam	- reserved.

Returns: KER_TRUE - option enabled; KER_FALSE - option disabled

◆ upiNfcDeInit()

KER_RES KER_API upiNfcDeInit ( KER_CTX_SINGLE_PARAM )

Performs kernel de-initialization.

Returns: KER_OK Success.; Other - failure.

Terminal Application should de-init kernel by this function

Warning: Do not call this function if upiNfcInit failed.

◆ upiNfcGetData()

KER_RES KER_API upiNfcGetData	(	KER_CTX_PARAM KER_TRAN *	pTran,
		KER_INT16U	usOptions,
		KER_BYTE *	pbtData,
		KER_INT16U *	pusDataLen
	)

Transaction data request.

call this function to obtain transaction data from kernel (as a flat TLV with all data available)

Parameters

[in]	pTran	- pointer to the transaction structure (obtained by upiNfcTran)
[in]	usOptions	- get options (bitmask), reserved
[out]	pbtData	- Buffer to obtain transaction data (in TLV) (path KER_NULL if you need to calculate tran data length only)
[in,out]	pusDataLen	- Size of Buffer pbtData as input, data length as output

Returns: KER_OK Success; Other Failure

◆ upiNfcGetDataByTag()

KER_RES KER_API upiNfcGetDataByTag	(	KER_CTX_PARAM KER_TRAN *	pTran,
		KER_INT16U	usOptions,
		const KER_BYTE *	pbtTag,
		KER_BYTE	btTagSize,
		KER_BYTE *	pbtData,
		KER_INT16U *	pusDataSize
	)

transaction data request

call this function to obtain transaction data by tag from kernel

Parameters

[in]	pTran	- pointer to the transaction structure (obtained by upiNfcTran)
[in]	usOptions	- get options (bitmask), reserved
[in]	pbtTag	- buffer with tag value
[in]	btTagSize	- pbtTag value length
[out]	pbtData	- buffer to obtain provided tag value
[in,out]	pusDataSize	- pbtData buffer size as input, output containes result data length

Returns: KER_OK Success; KER_ERR_COMMON_NOT_FOUND Tag not found; Other Failure

◆ upiNfcGetDataByTagList()

KER_RES KER_API upiNfcGetDataByTagList	(	KER_CTX_PARAM KER_TRAN *	pTran,
		KER_INT16U	usOptions,
		const KER_BYTE *	pbtTagList,
		KER_INT16U	usTagListSize,
		KER_BYTE *	pbtData,
		KER_INT16U *	pusDataSize
	)

transaction data request

call this function to obtain transaction data by tag list from kernel

Parameters

[in]	pTran	- pointer to the transaction structure (obtained by upiNfcTran)
[in]	usOptions	- get options (bitmask), reserved
[in]	pbtTagList	- buffer with tag list
[in]	usTagListSize	- pbtTagList value length
[out]	pbtData	- buffer to obtain provided tag list in TLV format
[in,out]	pusDataSize	- pbtData buffer size as input, output containes result data length

Returns: KER_OK Success; Other Failure

◆ upiNfcInit()

KER_RES KER_API upiNfcInit	(	KER_CTX_INIT_PARAM const KER_VOID *	pConfigID,
		KER_INT16U	usConfigIDLen,
		const KER_CHAR *	pchKernelFiles,
		KER_INT16U	usKernelFilesLen
	)

Performs kernel initialization.

Parameters

[in]	pConfigID	Buffer with configuration ID obtained from Terminal Application (in HAL recognized format)
[in]	usConfigIDLen	pConfigID buffer length
[in]	pchKernelFiles	buffer with kernel binary file names (for checksum calculation) - set of nul terminated strings ended by nul.
[in]	usKernelFilesLen	length of pchKernelFiles including nul-terminating sym

Returns: KER_OK Success.; Other - failure.

Terminal Application should init kernel by this function before calling any other kernel functions

Warning: If upiNfcInit returns KER_OK, Terminal Application should call upiNfcDeInit finally to release allocated resources.

◆ upiNfcTran()

KER_RES KER_API upiNfcTran	(	KER_CTX_PARAM const NFC_EP_PRE_DATA *	pEpPRE,
		const NFC_EP_PPSE_DATA *	pEpPPSE,
		const NFC_EP_TRAN_DATA *	pEpTranData,
		KER_TRAN **	ppTran,
		NFC_OUTCOME **	ppOutcome
	)

Initiates transaction processing by kernel.

This function initiates NFC transaction processing by kernel, based on Select command results (from EP)

Parameters

[in]	pEpPRE	- Entry Point preprocesing data
[in]	pEpPPSE	- Entry Point selected aid related PPSE data
[in]	pEpTranData	- transaction data maintained by Entry Point
[out]	ppTran	- pointer to obtain transaction context
[out]	ppOutcome	- pointer to obtain transaction outcome

Returns: KER_OK Success, see outcome for details.; KER_ERR_COMMON_CARD_HW_ERR Card communication failure - abort transaction; Other errors (Kernel Error Codes) Failure - abort transaction.

Warning: When tranaction context (ppTran) no longer required call kerTranRelease. Do it despite of result code retuned.; ppOutcome reference to transaction outcome valid till transaction completion.

◆ upiNfcTranRelease()

KER_BOOL KER_API upiNfcTranRelease ( KER_CTX_PARAM KER_TRAN * pTran )

Releases NFC Transaction container structure.

Parameters

[in] pTran - pointer to the transaction structure to release (obtained by upiNfcTran)

Returns: KER_TRUE Success.; KER_FALSE Failure. Execution failed due to invalid param or memory error.

◆ upiNfcVerInfo()

KER_BOOL KER_API upiNfcVerInfo	(	KER_CTX_PARAM const KER_CHAR **	ppchEmvVer,
		KER_INT16U *	pusEmvVerLen,
		const KER_CHAR **	ppchLibVer,
		KER_INT16U *	pusLibVerLen
	)

Obtains emv kernel library version info.

Parameters

[out]	ppchEmvVer	pointer to obtain reference to Kernel Specification version info (optional, set KER_NULL if you don't need it)
[out]	pusEmvVerLen	length of data, including nul-terminated symbol (optional, set KER_NULL if you don't need it)
[out]	ppchLibVer	pointer to obtain reference to kernel library version info (optional, set KER_NULL if you don't need it)
[out]	pusLibVerLen	length of data, including nul-terminated symbol (optional, set KER_NULL if you don't need it)

Returns: KER_TRUE Success.; KER_FALSE Failure. Execution failed due to invalid param.

Functions

Detailed Description

Function Documentation

◆ upiCheckOption()

◆ upiNfcDeInit()

◆ upiNfcGetData()

◆ upiNfcGetDataByTag()

◆ upiNfcGetDataByTagList()

◆ upiNfcInit()

◆ upiNfcTran()

◆ upiNfcTranRelease()

◆ upiNfcVerInfo()